Skip to main content

2.2.2. Querry string parametrs

Parametrs

Main Parameters

ParameterDescriptionMandatoryTypeNotes
countryCountry codeYesstring
nameOrganization nameYesstring
fiscal_idTax identification numberYesstring
is_legalIndicator of legal entity (true/false)booleanTrue by default
contract_numContract numberYesstring
contact_nameContact person
regionRegion namestringIf not found in the directory, it will be added
districtDistrict namestringIf not found in the directory, it will be added
addressOrganization addressYesstring
emailEmail addressYesstring
phoneOrganization phone numberYesstring
activitiesArray of activity typesarray of objectsSee activities Array Structure below
shop_nameStore nameYes (mandatory and key if shop code is not used)string
shop_addressStore addressYesstring
shop_phoneStore phone numberstring
shop_codeStore codestringMandatory if used
shop_typeType of retail outletstring
license_numCash register license number; mandatory and keyYes (if “dev_model” and “serial” values ​​are not passed)string
dev_modelDevice modelYes (f “license_num” is not passed)string
serialSerial numberYes (f “license_num” is not passed)string
tokenCash register fiscal tokenstring

activities Array Structure

ParameterDescriptionMandatoryTypeNotes
codeActivity code
nameActivity name

Code structure

{
"country": "",
"name": "",
"fiscal_id": "",
"is_legal": true,
"contract_num": "",
"region": "",
"district": "",
"address": "",
"email": "",
"phone": "",
"activities": [
{
"code": "",
"name": ""
}
],
"shop_name": "",
"shop_address": "",
"shop_phone": "",
"shop_code": "",
"shop_type": "",
"license_num": "",
"dev_model": "",
"serial": "",
"token": ""
}

Field Descriptions

  • country – country code, required, string
  • name – organization name, required, string
  • fiscal_id – tax identification number, required, string
  • is_legal – legal entity indicator, boolean, default True
  • contract_num – contract number, required, string
  • region – region name, added automatically if not found in directory, string
  • district – district name, added automatically if not found in directory, string
  • address – organization address, required, string
  • email – email address, required, string
  • phone – organization phone number, required, string
  • activities – array of activity types (objects with "code" and "name"), optional
  • shop_name – store name, required and key if shop_code is not used, string
  • shop_address – store address, required, string
  • shop_phone – store phone number, string
  • shop_code – store code, key if used, string
  • shop_type – type of retail point, string
  • license_num – cash register license number, required and key if dev_model and serial are not provided, string
  • dev_model – device model, required if license_num is not provided, string
  • serial – device serial number, required if license_num is not provided, string
  • token – fiscal token number, string